Skip to content

DOC: remove extra spaces from option descriptions #7674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 7, 2014
Merged

DOC: remove extra spaces from option descriptions #7674

merged 1 commit into from
Jul 7, 2014

Conversation

jorisvandenbossche
Copy link
Member

There are already 4 spaces in the description strings in config_init.py, so no need to add some more.
This caused the descriptions to be longer than 79 characters, and so line wrapping in the terminal. Closes #6838.

Plus, moved the default and current values to the last line of the description as proposed by @jseabold

Example output now is:

display.max_colwidth : int
    The maximum width in characters of a column in the repr of
    a pandas data structure. When the column overflows, a "..."
    placeholder is embedded in the output.
    [default: 50] [currently: 50]

display.max_info_columns : int
    max_info_columns is used in DataFrame.info method to decide if
    per column information will be printed.
    [default: 100] [currently: 100]

Previous in 0.14 this was:

display.max_colwidth : [default: 50] [currently: 50]: int
        The maximum width in characters of a column in the repr of
        a pandas data structure. When the column overflows, a "..."
        placeholder is embedded in the output.

display.max_info_columns : [default: 100] [currently: 100]: int
        max_info_columns is used in DataFrame.info method to decide if
        per column information will be printed.

Before 0.14 it was worse (as reported in #6838), but I already improved it a bit some time ago.

@jorisvandenbossche
DOC: better format of option descriptions
497cbc1 
- remove extra spaces from option descriptions (already in strings in config_init.py)
- move default and current value to last line
@jreback jreback added the Docs label Jul 6, 2014
@jreback jreback added this to the 0.14.1 milestone Jul 6, 2014
jorisvandenbossche added a commit that referenced this pull request Jul 7, 2014
@jorisvandenbossche
Merge pull request #7674 from jorisvandenbossche/doc-options-docstrin…
83a7d77 
…gwidth

DOC: remove extra spaces from option descriptions
@jorisvandenbossche jorisvandenbossche merged commit 83a7d77 into pandas-dev:master Jul 7, 2014
@jorisvandenbossche jorisvandenbossche deleted the doc-options-docstringwidth branch July 7, 2014 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
0.14.1
Development

Successfully merging this pull request may close these issues.

DOC: set_option docstring
2 participants
@jorisvandenbossche @jreback